Index

api/v1/stock/{stockno}/qtybylocations

Path: api/v1/stock/{stockno}/qtybylocations

This API is JSON:API compliant.

This endpoint supports the following methods:
GET

The resource type for this endpoint is StockQtyByLocations
The identifier is stockNo-locationNo

The StockQtyByLocations resource type attributes are as follows:

{
The internal company number used to identify the location. This will only be returned if multi company is enabled.
optional
"companyNo":integer Note: Will not be returned in the response if value is null.
The code of the card file linked to the company. This will only be returned if multi company is enabled.
"companyCode":string Note: Will not be returned in the response if value is null.
The internal branch number used to identify the branch. This will only be returned if branch is enabled.
optional
"branchNo":integer Note: Will not be returned in the response if value is null.
The branch code. This will only be returned if branch is enabled.
"branchCode":string Note: Will not be returned in the response if value is null.
The internal location number used to identify the location.
"locationNo":integer
The location code where the stock is located.
"locationCode":string
How many are currently in stock.
"onHand":number
How many are required for jobs.
"comitted":number
How many are currently on transfer to this location.
"onTransfer":number
How many are currently in jobs which are reserved/ready.
"reserved":number
How many are listed in purchase orders which are not received or finished.
"onPO":number
How many are available for sale.
"available":number
Quantity on Back Order.
"backOrder":number
Quantity being manufactured. This will only be returned if the stock is set as manufactured.
optional
"manufacturing":number Note: Will not be returned in the response if value is null.
}

Example GET (Return all)

Path: api/v1/stock/2/qtybylocations

Response:

{
    "data": [
        {
            "id": "2-1",
            "type": "StockQtyByLocations",
            "attributes": {
                "locationNo": 1,
                "locationCode": "ACT",
                "onHand": 152.0000,
                "comitted": 109.0000,
                "onTransfer": 0.0,
                "reserved": 5.0000,
                "onPO": 46.0000,
                "available": 43.0000,
                "backOrder": 0.0000
            }
        },
        {
            "id": "2-2",
            "type": "StockQtyByLocations",
            "attributes": {
                "locationNo": 2,
                "locationCode": "nsw",
                "onHand": 12.0000,
                "comitted": 10.0000,
                "onTransfer": 0.0,
                "reserved": 0.0000,
                "onPO": 0.0000,
                "available": 2.0000,
                "backOrder": 0.0000
            }
        }
	]
}

Example GET (Return specific)

Path: api/v1/stock/2/qtybylocations/2-2

Response:

{
    "data": {
		"id": "2-2",
		"type": "StockQtyByLocations",
		"attributes": {
			"locationNo": 2,
			"locationCode": "nsw",
			"onHand": 12.0000,
			"comitted": 10.0000,
			"onTransfer": 0.0,
			"reserved": 0.0000,
			"onPO": 0.0000,
			"available": 2.0000,
			"backOrder": 0.0000
		}
	}
}

Generated from Jim2 version 4.6.9804.70